home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / lib / perl5 / Gnome2 / FileEntry.pod < prev    next >
Encoding:
Text File  |  2008-06-15  |  3.6 KB  |  225 lines

  1. =head1 NAME
  2.  
  3. Gnome2::FileEntry
  4.  
  5. =head1 HIERARCHY
  6.  
  7.   Glib::Object
  8.   +----Glib::InitiallyUnowned
  9.        +----Gtk2::Object
  10.             +----Gtk2::Widget
  11.                  +----Gtk2::Container
  12.                       +----Gtk2::Box
  13.                            +----Gtk2::VBox
  14.                                 +----Gnome2::FileEntry
  15.  
  16. =head1 INTERFACES
  17.  
  18.   Glib::Object::_Unregistered::AtkImplementorIface
  19.   Gtk2::Buildable
  20.   Gtk2::Editable
  21.  
  22.  
  23. =head1 METHODS
  24.  
  25. =head2 widget = Gnome2::FileEntry-E<gt>B<new> ($history_id, $browse_dialog_title)
  26.  
  27. =over
  28.  
  29. =over
  30.  
  31. =item * $history_id (string) 
  32.  
  33. =item * $browse_dialog_title (string) 
  34.  
  35. =back
  36.  
  37. =back
  38.  
  39. =head2 $fentry-E<gt>B<set_default_path> ($path)
  40.  
  41. =over
  42.  
  43. =over
  44.  
  45. =item * $path (string) 
  46.  
  47. =back
  48.  
  49. =back
  50.  
  51. =head2 boolean = $fentry-E<gt>B<get_directory_entry> 
  52.  
  53. =over
  54.  
  55. =back
  56.  
  57. =head2 $fentry-E<gt>B<set_directory_entry> ($directory_entry)
  58.  
  59. =over
  60.  
  61. =over
  62.  
  63. =item * $directory_entry (boolean) 
  64.  
  65. =back
  66.  
  67. =back
  68.  
  69. =head2 $fentry-E<gt>B<set_filename> ($filename)
  70.  
  71. =over
  72.  
  73. =over
  74.  
  75. =item * $filename (string) 
  76.  
  77. =back
  78.  
  79. =back
  80.  
  81. =head2 string = $fentry-E<gt>B<get_full_path> ($file_must_exist)
  82.  
  83. =over
  84.  
  85. =over
  86.  
  87. =item * $file_must_exist (boolean) 
  88.  
  89. =back
  90.  
  91. =back
  92.  
  93. =head2 widget = $fentry-E<gt>B<gnome_entry> 
  94.  
  95. =over
  96.  
  97. =back
  98.  
  99. =head2 widget = $fentry-E<gt>B<gtk_entry> 
  100.  
  101. =over
  102.  
  103. =back
  104.  
  105. =head2 boolean = $fentry-E<gt>B<get_modal> 
  106.  
  107. =over
  108.  
  109. =back
  110.  
  111. =head2 $fentry-E<gt>B<set_modal> ($is_modal)
  112.  
  113. =over
  114.  
  115. =over
  116.  
  117. =item * $is_modal (boolean) 
  118.  
  119. =back
  120.  
  121. =back
  122.  
  123. =head2 $fentry-E<gt>B<set_title> ($browse_dialog_title)
  124.  
  125. =over
  126.  
  127. =over
  128.  
  129. =item * $browse_dialog_title (string) 
  130.  
  131. =back
  132.  
  133. =back
  134.  
  135.  
  136. =head1 PROPERTIES
  137.  
  138. =over
  139.  
  140. =item 'browse-dialog-title' (string : readable / writable)
  141.  
  142. Title for the Browse file dialog.
  143.  
  144. =item 'default-path' (string : readable / writable)
  145.  
  146. Default path for the Browse file window.
  147.  
  148. =item 'directory-entry' (boolean : readable / writable)
  149.  
  150. Whether the file entry is being used to enter directory names or complete filenames.
  151.  
  152. =item 'filechooser-action' (Gtk2::FileChooserAction : readable / writable)
  153.  
  154. The type of operation that the file selector is performing.
  155.  
  156. =item 'filename' (string : readable / writable)
  157.  
  158. Filename that should be displayed in the file entry.
  159.  
  160. =item 'gnome-entry' (Gnome2::Entry : readable)
  161.  
  162. GnomeEntry that the file entry uses for entering filenames.  You can use this property to get the GnomeEntry if you need to modify or query any of its parameters.
  163.  
  164. =item 'gtk-entry' (Gtk2::Entry : readable)
  165.  
  166. GtkEntry that the file entry uses for entering filenames.  You can use this property to get the GtkEntry if you need to modify or query any of its parameters.
  167.  
  168. =item 'history-id' (string : readable / writable)
  169.  
  170. Unique identifier for the file entry.  This will be used to save the history list.
  171.  
  172. =item 'modal' (boolean : readable / writable)
  173.  
  174. Whether the Browse file window should be modal.
  175.  
  176. =item 'use-filechooser' (boolean : readable / writable)
  177.  
  178. Whether to use the new GtkFileChooser widget or the GtkFileSelection widget to select files.
  179.  
  180. =back
  181.  
  182.  
  183. =head1 SIGNALS
  184.  
  185. =over
  186.  
  187. =item B<activate> (Gnome2::FileEntry)
  188.  
  189. =item B<browse-clicked> (Gnome2::FileEntry)
  190.  
  191. =back
  192.  
  193.  
  194. =head1 ENUMS AND FLAGS
  195.  
  196. =head2 enum Gtk2::FileChooserAction
  197.  
  198. =over
  199.  
  200. =item * 'open' / 'GTK_FILE_CHOOSER_ACTION_OPEN'
  201.  
  202. =item * 'save' / 'GTK_FILE_CHOOSER_ACTION_SAVE'
  203.  
  204. =item * 'select-folder' / 'GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER'
  205.  
  206. =item * 'create-folder' / 'GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER'
  207.  
  208. =back
  209.  
  210.  
  211.  
  212. =head1 SEE ALSO
  213.  
  214. L<Gnome2>, L<Glib::Object>, L<Glib::InitiallyUnowned>, L<Gtk2::Object>, L<Gtk2::Widget>, L<Gtk2::Container>, L<Gtk2::Box>, L<Gtk2::VBox>
  215.  
  216. =head1 COPYRIGHT
  217.  
  218. Copyright (C) 2003-2004 by the gtk2-perl team.
  219.  
  220. This software is licensed under the LGPL.  See L<Gnome2> for a full notice.
  221.  
  222.  
  223. =cut
  224.  
  225.